home *** CD-ROM | disk | FTP | other *** search
/ Aminet 7 / Aminet 7 - August 1995.iso / Aminet / comm / mebbs / cdrid102.lha / CDRomID / CDRomID.doc < prev    next >
Text File  |  1994-06-22  |  9KB  |  235 lines
  1.  
  2.                  ********************************************
  3.                  *                                          *
  4.                  *           CDRomID Version 1.02           *
  5.                  *                                          *
  6.                  *      Written By, Jason Gouger[M2018]     *
  7.                  *    Copyright 1994  All rights reserved   *
  8.                  ********************************************
  9.  
  10.  
  11. DISCLAIMER:
  12. ~~~~~~~~~~
  13.      The usual disclaimers concerning computer software apply to this
  14. product.  Although this program has been tested extensively for its 
  15. accuracy and reliability, the author will accept no liability whatsoever
  16. for damage resulting from the use, misuse, or excessive use of it. The
  17. author also takes no responsibility for data loss or corruption of data
  18. caused by this program! USE IT AT YOUR OWN RISK!
  19.  
  20.  
  21. What CDRomID does:
  22. ~~~~~~~~~~~~~~~~~
  23.     This door will allow user's to directly access a CDRom or any other
  24. device in a "safe" manner.  I have set this door up for use with the
  25. AmiNet CDRom, but I am sure it can be used with other CDRom's.  The
  26. door allows users to search an Index file which contains a list of the
  27. programs with a Grep type of command.  The matches will be returned and
  28. then the user may download the file with the complete filename.  It will
  29. check to make sure the user has enough download credits and charge the
  30. account.
  31.  
  32. Set up:
  33. ~~~~~~
  34. Files included in the archive: 
  35.  
  36.       1) CDRomID       ====>  CDRomID Door File
  37.       2) CDRomID.CFG   ====>  Configuration File
  38.       3) Intro.txt     ====>  Graphics file displayed upon door entry
  39.       4) Help.txt      ====>  Graphics help file.
  40.       5) CDRomID.doc   ====>  CDRomID Documentation
  41.  
  42. Place the above files in a Directory Called CDRomID in the Doors: 
  43. Assignment.
  44.  
  45. ***Note*** You need a Grep command to search the INDEX file. I am
  46.            using AGrep to search the list.  Make sure you place the
  47.            EXACT command you would like to be executed in the COMMAND
  48.            option.  Also, do not forget to include the INDEX filename
  49.            to be searched and the options of the Grep command.  If
  50.            you need a copy of AGrep you can contact my BBS.
  51.  
  52.  
  53. How to have several CDRom's online:
  54. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  55. To have multiple CDRom's online you should do the following.
  56.  
  57.      1) Duplicate the door with a different name.  This can be done
  58.         with the Copy or MakeLink command with the following syntax:
  59.  
  60.              Copy DOORS:CDRomID/CDRomID DOORS:CDRomID/AmiNetCD
  61.  
  62.           -OR- (2.04 or greater)
  63.  
  64.                  MakeLink DOORS:CDRomID/AmiNetCD DOORS:CDRomID/CDRomID
  65.  
  66.              (This option will *NOT* use disk space)  See your AmigaOS
  67.               reference for more information)
  68.  
  69.      2) Create a config file with the *SAME* name as the door, except
  70.         with the .CFG extension appended.  The configuration filename
  71.         for the above example:
  72.  
  73.              DOORS:CDRomID/AmiNetCD.CFG
  74.  
  75. This type of setup allows for the customization of *EACH* CDRom.
  76. Basically the configuration file will have the *SAME* name from which
  77. the CDRomID door was executed from, with the .CFG extension appened.
  78.  
  79.  
  80. How to configure the CDRomID.CFG file:
  81. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  82. Only lines preceded by the pound sign (#) will be considered as a 
  83. configuration entry.  Also, there should be *NO SPACES* between the
  84. pound sign and the config entry *AND* the argument must be *FLUSH*
  85. with the equals sign (=).  
  86.  
  87. The configuration file is *CASE SENSITIVE*:
  88.  
  89.    1) COMMAND    - Command used to search the INDEX file.  The
  90.                    first %s will be replaced by the Temporary
  91.                    filename and the second by the search string.
  92.    2) TEMPFILE   - Temporary filename where the search information
  93.                    will be returned to.  Note, the LineNumber will
  94.                    be appended to this filename thus, allowing
  95.                    multiple accesses to this door.
  96.    3) FILETEMP   - Temporary directory where a requested download
  97.                    will be stored while the file is being downloaded.
  98.                    This will speed up file access if multiple user's
  99.                    are accessing the CDRom.  If this option is omited
  100.                    files will be directly downloaded from the CDRom.
  101.    4) CDROMFILES - Location of the files.
  102.    5) HEADER     - The *COMPLETE* filename of the graphics file
  103.                    to be displayed before search output.
  104.    6) INTRO      - The *COMPLETE* filename of the graphics file
  105.                    to be displayed upon door entry.
  106.    7) HELP       - The *COMPLETE* filename of the graphics file
  107.                    to be displayed for help information.
  108.    8) FREE       - Makes file(s) free.  (You can have multiple
  109.                    FREE entries)  The filename will be compared
  110.                    to the entry's length.  So if you had comm/bbs
  111.                    as free files that had the filename of
  112.                    comm/bbs/WhatEver would be considered free.
  113.    8) ALLFREE    - Makes ALL files free.
  114.  
  115.  
  116. Example Configuration File:
  117. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  118. #COMMAND=DOORS:CDRomID/AGrep >%s -i "%s" AMINET_0294:INDEX
  119. #TEMPFILE=T:CDRomID
  120. #FILETEMP=T:
  121. #CDROMFILES=AMINET_0294:AMINET/
  122. #HEADER=DOORS:CDRomID/Header
  123. #INTRO=DOORS:CDRomID/Intro
  124. #HELP=DOORS:CDRomID/Help
  125. #FREE=INDEX
  126.  
  127. Things to notice: 1) There are *NO* spaces in the configuration entries.
  128.                   2) You may need quotes around the %s if your path has
  129.                      a space in it.
  130.                   3) You *SHOULD* have quotes around the search string %s.
  131.  
  132. Usage:
  133. ~~~~~
  134.       This door is a "MultiRunDoor" type, so to add this door to a menu
  135. you would have something like the following:
  136.  
  137.       Function R
  138.          MultiRunDoor "DOORS:CDRomID/CDRomID"
  139.       end
  140.  
  141.    -> When executed this door will look for a configuration file called:
  142.  
  143.       DOORS:CDRomID/CDRomID.CFG
  144.  
  145.  
  146. With a second CDRom, use an AmiNet CDRom for example you could have the
  147. following:
  148.  
  149.       Function S
  150.          MultiRunDoor "DOORS:CDRomID/AmiNetCD"
  151.       end
  152.  
  153.     -> When executed this door will look for a configuration file called:
  154.  
  155.       DOORS:CDRomID/AmiNetCD.CFG
  156.  
  157.  
  158. Door Usage:
  159. ~~~~~~~~~~
  160.       The door is pretty self explanatory to operate, but I will go over
  161. a basic outline.  When a user enters the door the Intro.[gfx] will be 
  162. shown.  The user will then be prompted to Search, Download, Display
  163. the Help File, or Quit.
  164.  
  165.       The Search option will prompt for a search string.  This string
  166. will be passed directly to your Grep Command.  Any back quotes (`) or
  167. double quotations will be converted to a single quote (').  This
  168. secures the user from making any "Escape Commands" to your system.
  169.  
  170.       The download option will prompt the user for the FULL filename.
  171. This filename will be appended to the CDROMFILES configuration
  172. entry.  This also secures your system from users downloading on other
  173. devices/assignments.
  174.  
  175.       The Help option will display the graphics help file, and the quit
  176. option will obviously exit the door.  The door checks to make sure the
  177. volume is mounted before every access to the CD-Rom is made.  If you
  178. were to take the CD-Rom offline, then user will be told that the CD-Rom
  179. has been taken offline and to try again later, and a Volume requestor
  180. will not pop up.
  181.  
  182. GiftWare:
  183. ~~~~~~~~
  184.      If you like this program you can make donations to the
  185. following address and make an checks payable to me. Programmers
  186. are inspired by donations!
  187.  
  188.           Jason Gouger
  189.           74 White Birch Lane
  190.           East Stroudsburg, PA 18301-8339
  191.  
  192.     If you have any questions I can be reached at my bbs.
  193.  
  194.     The Amiga Enterprise    717-223-8269   300-14400 Bps   24 Hours
  195.  
  196.  
  197. Comments and Bug Reports:
  198. ~~~~~~~~~~~~~~~~~~~~~~~~
  199.     Send Comments and Bug reports to:
  200.                 Jason Gouger - Fidonet 1:268/114
  201.                 Jason Gouger - MaxNet 90:7170/2
  202.                 Jason Gouger - Proper Mebbs Echo
  203.                 JGouger@psu.edu - Internet Address
  204.  
  205.  
  206. Other Doors by Me:
  207. ~~~~~~~~~~~~~~~~~~~~
  208.   UserID [V1.60]  -   Displays any number of last callers.  It is 100% 
  209.                       configurable!  Give it a try.  You can make you
  210.                       OWN display output to suit your system.  The door
  211.                       uses text control sequences to insert the last
  212.                       caller information where ever you choose. Try it
  213.                       out!
  214.  
  215.   MQwkID [V0.01]  -   Allow user's the opportunity to download 
  216.                       messages from MULTIPLE message areas for offline
  217.                       reading and response.  The user's will be able to
  218.                       read the mail with any QWK compatible reader. This
  219.                       door also severs as a tosser for the reply packets.
  220.  
  221.  
  222. History:
  223. ~~~~~~~
  224.     1.00 ==> First Release
  225.  
  226.     1.01 ==> The proper temporary file was not being created.
  227.  
  228.     1.02 ==> Added support for multiple CDRom's
  229.              Added the ability for a temporary download storage directory.
  230.  
  231.     Bugs: A User's account will be charged for a download even if it
  232.           is *NOT* sucessful!!!  This includes aborted downloads.  This
  233.           will be fixed as soon as the SendFile() function returns if it
  234.           is sucessful :)
  235.